home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sgbsv.z / sgbsv
Encoding:
Text File  |  2002-10-03  |  6.0 KB  |  199 lines

  1.  
  2.  
  3.  
  4. SSSSGGGGBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSGGGGBBBBSSSSVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGBSV - compute the solution to a real system of linear equations A * X =
  10.      B, where A is a band matrix of order N with KL subdiagonals and KU
  11.      superdiagonals, and X and B are N-by-NRHS matrices
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE SGBSV( N, KL, KU, NRHS, AB, LDAB, IPIV, B, LDB, INFO )
  15.  
  16.          INTEGER       INFO, KL, KU, LDAB, LDB, N, NRHS
  17.  
  18.          INTEGER       IPIV( * )
  19.  
  20.          REAL          AB( LDAB, * ), B( LDB, * )
  21.  
  22. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  23.      These routines are part of the SCSL Scientific Library and can be loaded
  24.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  25.      directs the linker to use the multi-processor version of the library.
  26.  
  27.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  28.      4 bytes (32 bits). Another version of SCSL is available in which integers
  29.      are 8 bytes (64 bits).  This version allows the user access to larger
  30.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  31.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  32.      only one of the two versions; 4-byte integer and 8-byte integer library
  33.      calls cannot be mixed.
  34.  
  35. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  36.      SGBSV computes the solution to a real system of linear equations A * X =
  37.      B, where A is a band matrix of order N with KL subdiagonals and KU
  38.      superdiagonals, and X and B are N-by-NRHS matrices. The LU decomposition
  39.      with partial pivoting and row interchanges is used to factor A as A = L *
  40.      U, where L is a product of permutation and unit lower triangular matrices
  41.      with KL subdiagonals, and U is upper triangular with KL+KU
  42.      superdiagonals.  The factored form of A is then used to solve the system
  43.      of equations A * X = B.
  44.  
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      N       (input) INTEGER
  48.              The number of linear equations, i.e., the order of the matrix A.
  49.              N >= 0.
  50.  
  51.      KL      (input) INTEGER
  52.              The number of subdiagonals within the band of A.  KL >= 0.
  53.  
  54.      KU      (input) INTEGER
  55.              The number of superdiagonals within the band of A.  KU >= 0.
  56.  
  57.      NRHS    (input) INTEGER
  58.              The number of right hand sides, i.e., the number of columns of
  59.              the matrix B.  NRHS >= 0.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSGGGGBBBBSSSSVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      AB      (input/output) REAL array, dimension (LDAB,N)
  75.              On entry, the matrix A in band storage, in rows KL+1 to
  76.              2*KL+KU+1; rows 1 to KL of the array need not be set.  The j-th
  77.              column of A is stored in the j-th column of the array AB as
  78.              follows:  AB(KL+KU+1+i-j,j) = A(i,j) for max(1,j-
  79.              KU)<=i<=min(N,j+KL) On exit, details of the factorization: U is
  80.              stored as an upper triangular band matrix with KL+KU
  81.              superdiagonals in rows 1 to KL+KU+1, and the multipliers used
  82.              during the factorization are stored in rows KL+KU+2 to 2*KL+KU+1.
  83.              See below for further details.
  84.  
  85.      LDAB    (input) INTEGER
  86.              The leading dimension of the array AB.  LDAB >= 2*KL+KU+1.
  87.  
  88.      IPIV    (output) INTEGER array, dimension (N)
  89.              The pivot indices that define the permutation matrix P; row i of
  90.              the matrix was interchanged with row IPIV(i).
  91.  
  92.      B       (input/output) REAL array, dimension (LDB,NRHS)
  93.              On entry, the N-by-NRHS right hand side matrix B.  On exit, if
  94.              INFO = 0, the N-by-NRHS solution matrix X.
  95.  
  96.      LDB     (input) INTEGER
  97.              The leading dimension of the array B.  LDB >= max(1,N).
  98.  
  99.      INFO    (output) INTEGER
  100.              = 0:  successful exit
  101.              < 0:  if INFO = -i, the i-th argument had an illegal value
  102.              > 0:  if INFO = i, U(i,i) is exactly zero.  The factorization has
  103.              been completed, but the factor U is exactly singular, and the
  104.              solution has not been computed.
  105.  
  106. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  107.      The band storage scheme is illustrated by the following example, when M =
  108.      N = 6, KL = 2, KU = 1:
  109.  
  110.      On entry:                       On exit:
  111.  
  112.          *    *    *    +    +    +       *    *    *   u14  u25  u36
  113.          *    *    +    +    +    +       *    *   u13  u24  u35  u46
  114.          *   a12  a23  a34  a45  a56      *   u12  u23  u34  u45  u56
  115.         a11  a22  a33  a44  a55  a66     u11  u22  u33  u44  u55  u66
  116.         a21  a32  a43  a54  a65   *      m21  m32  m43  m54  m65   *
  117.         a31  a42  a53  a64   *    *      m31  m42  m53  m64   *    *
  118.  
  119.      Array elements marked * are not used by the routine; elements marked +
  120.      need not be set on entry, but are required by the routine to store
  121.      elements of U because of fill-in resulting from the row interchanges.
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGBBBBSSSSVVVV((((3333SSSS))))                                                            SSSSGGGGBBBBSSSSVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  141.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  142.  
  143.      This man page is available only online.
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.